GET api/account/contractnotes?clientID={clientID}&adviserID={adviserID}&licenseeID={licenseeID}&personID={personID}&startDate={startDate}&endDate={endDate}&contractNoteIDs[0]={contractNoteIDs[0]}&contractNoteIDs[1]={contractNoteIDs[1]}

Get contract notes. Transaction data is limited to a 180 day range.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientID	Client ID to filter on.	integer	None.
adviserID	Adviser ID to filter on.	integer	None.
licenseeID	Licensee ID to filter on.	integer	None.
personID	Person ID to filter on.	integer	None.
startDate	Start date range (UTC).	date	None.
endDate	End date range (UTC).	date	None.
contractNoteIDs	List of contract note IDs to filter on.	Collection of integer	None.

Body Parameters

None.

Response Information

Resource Description

Contract notes grouped by client account.

Collection of ClientContractNotes

Name	Description	Type	Additional information
ClientID	Unique client identifier	integer	None.
ExternalRef	External Reference of client	string	None.
ContractNotes	Contract notes	Collection of ContractNote	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ClientID": 1234,
    "ExternalRef": "This is an external reference",
    "ContractNotes": [
      {
        "ContractNoteID": 12345,
        "NettingOrderID": 1000,
        "SecurityCode": "AMP",
        "BuySell": 1,
        "ContractNoteTimestamp": "2024-09-29T14:49:40.548907+10:00",
        "Quantity": 1234,
        "Brokerage": 15.0,
        "CostBase": 10.0,
        "Fee": 2.0,
        "GrossValue": 500.0,
        "NetValue": 490.0,
        "References": [
          "Reference string 1",
          "Reference string 2"
        ],
        "OrderIDs": [
          1008
        ],
        "SettlementDate": "2024-10-02",
        "TradeDate": "2024-09-29",
        "AveragePrice": 0.405,
        "BrokerageGST": 1.88,
        "BrokerageExclGST": 0.0,
        "CorporateActions": "XD",
        "SharesPerContractMultiplier": 1000
      },
      {
        "ContractNoteID": 12400,
        "NettingOrderID": 1000,
        "SecurityCode": "TLS",
        "BuySell": 2,
        "ContractNoteTimestamp": "2024-09-29T14:49:40.548907+10:00",
        "Quantity": 1234,
        "Brokerage": 15.0,
        "CostBase": 10.0,
        "Fee": 2.0,
        "GrossValue": 500.0,
        "NetValue": 490.0,
        "References": [
          "Reference string 3",
          "Reference string 4"
        ],
        "OrderIDs": [
          1005,
          1006,
          1007
        ],
        "SettlementDate": "2024-10-02",
        "TradeDate": "2024-09-29",
        "AveragePrice": 0.405,
        "BrokerageGST": 1.88,
        "BrokerageExclGST": 0.0,
        "CorporateActions": "XD",
        "SharesPerContractMultiplier": 1
      }
    ]
  },
  {
    "ClientID": 5678,
    "ExternalRef": "This is an external reference",
    "ContractNotes": [
      {
        "ContractNoteID": 12345,
        "NettingOrderID": 1000,
        "SecurityCode": "AMP",
        "BuySell": 1,
        "ContractNoteTimestamp": "2024-09-29T14:49:40.548907+10:00",
        "Quantity": 1234,
        "Brokerage": 15.0,
        "CostBase": 10.0,
        "Fee": 2.0,
        "GrossValue": 500.0,
        "NetValue": 490.0,
        "References": [
          "Reference string 1",
          "Reference string 2"
        ],
        "OrderIDs": [
          1008
        ],
        "SettlementDate": "2024-10-02",
        "TradeDate": "2024-09-29",
        "AveragePrice": 0.405,
        "BrokerageGST": 1.88,
        "BrokerageExclGST": 0.0,
        "CorporateActions": "XD",
        "SharesPerContractMultiplier": 1000
      },
      {
        "ContractNoteID": 12400,
        "NettingOrderID": 1000,
        "SecurityCode": "TLS",
        "BuySell": 2,
        "ContractNoteTimestamp": "2024-09-29T14:49:40.548907+10:00",
        "Quantity": 1234,
        "Brokerage": 15.0,
        "CostBase": 10.0,
        "Fee": 2.0,
        "GrossValue": 500.0,
        "NetValue": 490.0,
        "References": [
          "Reference string 3",
          "Reference string 4"
        ],
        "OrderIDs": [
          1005,
          1006,
          1007
        ],
        "SettlementDate": "2024-10-02",
        "TradeDate": "2024-09-29",
        "AveragePrice": 0.405,
        "BrokerageGST": 1.88,
        "BrokerageExclGST": 0.0,
        "CorporateActions": "XD",
        "SharesPerContractMultiplier": 1
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfClientContractNotes xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Order">
  <ClientContractNotes>
    <ClientID>1234</ClientID>
    <ContractNotes xmlns:d3p1="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Order">
      <d3p1:ContractNote>
        <d3p1:AveragePrice>0.405</d3p1:AveragePrice>
        <d3p1:Brokerage>15.00</d3p1:Brokerage>
        <d3p1:BrokerageExclGST>0</d3p1:BrokerageExclGST>
        <d3p1:BrokerageGST>1.88</d3p1:BrokerageGST>
        <d3p1:BuySell>Buy</d3p1:BuySell>
        <d3p1:ContractNoteID>12345</d3p1:ContractNoteID>
        <d3p1:ContractNoteTimestamp>2024-09-29T14:49:40.548907+10:00</d3p1:ContractNoteTimestamp>
        <d3p1:CorporateActions>XD</d3p1:CorporateActions>
        <d3p1:CostBase>10.00</d3p1:CostBase>
        <d3p1:Fee>2.00</d3p1:Fee>
        <d3p1:GrossValue>500.00</d3p1:GrossValue>
        <d3p1:NetValue>490.00</d3p1:NetValue>
        <d3p1:NettingOrderID>1000</d3p1:NettingOrderID>
        <d3p1:OrderIDs xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>1008</d5p1:int>
        </d3p1:OrderIDs>
        <d3p1:Quantity>1234</d3p1:Quantity>
        <d3p1:References xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>Reference string 1</d5p1:string>
          <d5p1:string>Reference string 2</d5p1:string>
        </d3p1:References>
        <d3p1:SecurityCode>AMP</d3p1:SecurityCode>
        <d3p1:SettlementDate>2024-10-02T00:00:00+10:00</d3p1:SettlementDate>
        <d3p1:SharesPerContractMultiplier>1000</d3p1:SharesPerContractMultiplier>
        <d3p1:TradeDate>2024-09-29T00:00:00+10:00</d3p1:TradeDate>
      </d3p1:ContractNote>
      <d3p1:ContractNote>
        <d3p1:AveragePrice>0.405</d3p1:AveragePrice>
        <d3p1:Brokerage>15.00</d3p1:Brokerage>
        <d3p1:BrokerageExclGST>0</d3p1:BrokerageExclGST>
        <d3p1:BrokerageGST>1.88</d3p1:BrokerageGST>
        <d3p1:BuySell>Sell</d3p1:BuySell>
        <d3p1:ContractNoteID>12400</d3p1:ContractNoteID>
        <d3p1:ContractNoteTimestamp>2024-09-29T14:49:40.548907+10:00</d3p1:ContractNoteTimestamp>
        <d3p1:CorporateActions>XD</d3p1:CorporateActions>
        <d3p1:CostBase>10.00</d3p1:CostBase>
        <d3p1:Fee>2.00</d3p1:Fee>
        <d3p1:GrossValue>500.00</d3p1:GrossValue>
        <d3p1:NetValue>490.00</d3p1:NetValue>
        <d3p1:NettingOrderID>1000</d3p1:NettingOrderID>
        <d3p1:OrderIDs xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>1005</d5p1:int>
          <d5p1:int>1006</d5p1:int>
          <d5p1:int>1007</d5p1:int>
        </d3p1:OrderIDs>
        <d3p1:Quantity>1234</d3p1:Quantity>
        <d3p1:References xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>Reference string 3</d5p1:string>
          <d5p1:string>Reference string 4</d5p1:string>
        </d3p1:References>
        <d3p1:SecurityCode>TLS</d3p1:SecurityCode>
        <d3p1:SettlementDate>2024-10-02T00:00:00+10:00</d3p1:SettlementDate>
        <d3p1:SharesPerContractMultiplier>1</d3p1:SharesPerContractMultiplier>
        <d3p1:TradeDate>2024-09-29T00:00:00+10:00</d3p1:TradeDate>
      </d3p1:ContractNote>
    </ContractNotes>
    <ExternalRef>This is an external reference</ExternalRef>
  </ClientContractNotes>
  <ClientContractNotes>
    <ClientID>5678</ClientID>
    <ContractNotes xmlns:d3p1="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Order">
      <d3p1:ContractNote>
        <d3p1:AveragePrice>0.405</d3p1:AveragePrice>
        <d3p1:Brokerage>15.00</d3p1:Brokerage>
        <d3p1:BrokerageExclGST>0</d3p1:BrokerageExclGST>
        <d3p1:BrokerageGST>1.88</d3p1:BrokerageGST>
        <d3p1:BuySell>Buy</d3p1:BuySell>
        <d3p1:ContractNoteID>12345</d3p1:ContractNoteID>
        <d3p1:ContractNoteTimestamp>2024-09-29T14:49:40.548907+10:00</d3p1:ContractNoteTimestamp>
        <d3p1:CorporateActions>XD</d3p1:CorporateActions>
        <d3p1:CostBase>10.00</d3p1:CostBase>
        <d3p1:Fee>2.00</d3p1:Fee>
        <d3p1:GrossValue>500.00</d3p1:GrossValue>
        <d3p1:NetValue>490.00</d3p1:NetValue>
        <d3p1:NettingOrderID>1000</d3p1:NettingOrderID>
        <d3p1:OrderIDs xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>1008</d5p1:int>
        </d3p1:OrderIDs>
        <d3p1:Quantity>1234</d3p1:Quantity>
        <d3p1:References xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>Reference string 1</d5p1:string>
          <d5p1:string>Reference string 2</d5p1:string>
        </d3p1:References>
        <d3p1:SecurityCode>AMP</d3p1:SecurityCode>
        <d3p1:SettlementDate>2024-10-02T00:00:00+10:00</d3p1:SettlementDate>
        <d3p1:SharesPerContractMultiplier>1000</d3p1:SharesPerContractMultiplier>
        <d3p1:TradeDate>2024-09-29T00:00:00+10:00</d3p1:TradeDate>
      </d3p1:ContractNote>
      <d3p1:ContractNote>
        <d3p1:AveragePrice>0.405</d3p1:AveragePrice>
        <d3p1:Brokerage>15.00</d3p1:Brokerage>
        <d3p1:BrokerageExclGST>0</d3p1:BrokerageExclGST>
        <d3p1:BrokerageGST>1.88</d3p1:BrokerageGST>
        <d3p1:BuySell>Sell</d3p1:BuySell>
        <d3p1:ContractNoteID>12400</d3p1:ContractNoteID>
        <d3p1:ContractNoteTimestamp>2024-09-29T14:49:40.548907+10:00</d3p1:ContractNoteTimestamp>
        <d3p1:CorporateActions>XD</d3p1:CorporateActions>
        <d3p1:CostBase>10.00</d3p1:CostBase>
        <d3p1:Fee>2.00</d3p1:Fee>
        <d3p1:GrossValue>500.00</d3p1:GrossValue>
        <d3p1:NetValue>490.00</d3p1:NetValue>
        <d3p1:NettingOrderID>1000</d3p1:NettingOrderID>
        <d3p1:OrderIDs xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>1005</d5p1:int>
          <d5p1:int>1006</d5p1:int>
          <d5p1:int>1007</d5p1:int>
        </d3p1:OrderIDs>
        <d3p1:Quantity>1234</d3p1:Quantity>
        <d3p1:References xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>Reference string 3</d5p1:string>
          <d5p1:string>Reference string 4</d5p1:string>
        </d3p1:References>
        <d3p1:SecurityCode>TLS</d3p1:SecurityCode>
        <d3p1:SettlementDate>2024-10-02T00:00:00+10:00</d3p1:SettlementDate>
        <d3p1:SharesPerContractMultiplier>1</d3p1:SharesPerContractMultiplier>
        <d3p1:TradeDate>2024-09-29T00:00:00+10:00</d3p1:TradeDate>
      </d3p1:ContractNote>
    </ContractNotes>
    <ExternalRef>This is an external reference</ExternalRef>
  </ClientContractNotes>
</ArrayOfClientContractNotes>

text/csv

Sample:

"ExternalRef","ClientID","ContractNoteID","OrderNumber","BuySell","SecurityCode","Quantity","AveragePrice","BrokerageExclGST","BrokerageGST","Fee","GrossValue","NetValue","TradeDate","SettlementDate","ContractNoteTimestamp","CostBase","SharesPerContractMultiplier"
"This is an external reference","1234","12345","1008","Buy","AMP","1234","0.405","0","1.88","2.00","500.00","490.00","9/29/2024","10/2/2024","9/29/2024 2:49:40 PM","10.00","1000"
"This is an external reference","1234","12400","1005|1006|1007","Sell","TLS","1234","0.405","0","1.88","2.00","500.00","490.00","9/29/2024","10/2/2024","9/29/2024 2:49:40 PM","10.00","1"
"This is an external reference","5678","12345","1008","Buy","AMP","1234","0.405","0","1.88","2.00","500.00","490.00","9/29/2024","10/2/2024","9/29/2024 2:49:40 PM","10.00","1000"
"This is an external reference","5678","12400","1005|1006|1007","Sell","TLS","1234","0.405","0","1.88","2.00","500.00","490.00","9/29/2024","10/2/2024","9/29/2024 2:49:40 PM","10.00","1"

Error Response Information

Resource Description

Contract notes grouped by client account.

string

Error Response Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>

text/csv

Sample:

Failed to generate the sample for media type 'text/csv'. Cannot use formatter 'TPP.B2B.Webservices2.Utilities.CsvMediaTypeFormatter' to write type 'System.String'.